<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilocp: XilOcp Mailbox APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilocp
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__xocp__mailbox__apis.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">XilOcp Mailbox APIs</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga6bf28d17b9014d88926e36cd519dd804"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xocp__mailbox__apis.html#ga6bf28d17b9014d88926e36cd519dd804">XOcp_ProcessMailbox</a> (XMailbox *MailboxPtr, u32 *MsgPtr, u32 MsgLen)</td></tr>
<tr class="memdesc:ga6bf28d17b9014d88926e36cd519dd804"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends IPI request to the target module and gets the response from it.  <a href="#ga6bf28d17b9014d88926e36cd519dd804">More...</a><br/></td></tr>
<tr class="separator:ga6bf28d17b9014d88926e36cd519dd804"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga6bf28d17b9014d88926e36cd519dd804"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XOcp_ProcessMailbox </td>
          <td>(</td>
          <td class="paramtype">XMailbox *&#160;</td>
          <td class="paramname"><em>MailboxPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32 *&#160;</td>
          <td class="paramname"><em>MsgPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>MsgLen</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends IPI request to the target module and gets the response from it. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">MailboxPtr</td><td>- Pointer to mailbox instance </td></tr>
    <tr><td class="paramname">MsgPtr</td><td>- Pointer to the payload message </td></tr>
    <tr><td class="paramname">MsgLen</td><td>- Length of the message</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS - If the IPI send and receive is successful</li>
<li>XST_FAILURE - If there is a failure</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Payload consists of API id and call arguments to be written in IPI buffer </dd></dl>
<p>Sends IPI CDO to PLM, returns XST_FAILURE if sending data is failed</p>
<p>Waits for IPI response from PLM with a default timeout of 300 seconds. If the timeout exceeds then error is returned otherwise, it returns the status of the IPI response</p>

<p>Referenced by <a class="el" href="group__xocp__client__apis.html#ga0c6bb44603339209f55de3ef94141395">XOcp_ClientAttestWithDevAk()</a>, <a class="el" href="group__xocp__client__apis.html#ga43e275e75f776f74a124968aa83d29a2">XOcp_ClientAttestWithKeyWrapDevAk()</a>, <a class="el" href="group__xocp__client__apis.html#gabe2000beca7269b9e9f1ba0434adfbb7">XOcp_ExtendHwPcr()</a>, <a class="el" href="group__xocp__client__apis.html#gab8fbe7fbfcb136e816374b295b769972">XOcp_ExtendSwPcr()</a>, <a class="el" href="group__xocp__client__apis.html#gaebd4df862308eaeebbfb06a456a19f9f">XOcp_GenDmeResp()</a>, <a class="el" href="group__xocp__client__apis.html#ga50bd2fa853d6aba7c12fec38bb3867ae">XOcp_GenSharedSecretWithDevAk()</a>, <a class="el" href="group__xocp__client__apis.html#ga729ea6a53f3410b330a4eb6635074c88">XOcp_GetHwPcr()</a>, <a class="el" href="group__xocp__client__apis.html#ga36f63a2e8165e1f3360f8e2858d7aa53">XOcp_GetHwPcrLog()</a>, <a class="el" href="group__xocp__client__apis.html#gaaca4f4567e961877901f3ed298ed01e9">XOcp_GetSwPcr()</a>, <a class="el" href="group__xocp__client__apis.html#gaa9d5159f23ac4215dff07b1a16a0e2e9">XOcp_GetSwPcrData()</a>, <a class="el" href="group__xocp__client__apis.html#ga71a4d8aea262fc732fa812829dd891ae">XOcp_GetSwPcrLog()</a>, and <a class="el" href="group__xocp__client__apis.html#ga16013e82a245e7dfdd7a3c2e2df476e5">XOcp_GetX509Cert()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
